Skip to content

docs: Add documentation for utility scripts in controller_manager - #3175

Open
ultrasage-danz wants to merge 6 commits into
ros-controls:masterfrom
ultrasage-danz:add-utility-scripts-docs
Open

docs: Add documentation for utility scripts in controller_manager#3175
ultrasage-danz wants to merge 6 commits into
ros-controls:masterfrom
ultrasage-danz:add-utility-scripts-docs

Conversation

@ultrasage-danz

Copy link
Copy Markdown

Closes #488

Summary

Added comprehensive documentation for utility scripts:

  • controller_manager_services.SingletonServiceCaller: Service client utility for programmatic controller management
  • launch_utils.generate_controllers_spawner_launch_description(): Helper to generate launch descriptions
  • launch_utils.generate_controllers_spawner_launch_description_from_dict(): Dictionary-based alternative

Changes

  • Added "Utility scripts" section to controller_manager/doc/userdoc.rst
  • Included Python usage examples with terminal commands and expected outputs
  • Added complete lifecycle management example
  • Documented all supported services and use cases

Related

Addresses the missing documentation mentioned in #488 comment about generate_controllers_spawner_launch_description

riles1670 added 2 commits March 28, 2026 22:52
- Add detailed parameter structure for joint limiting
- Document three configuration methods: YAML, URDF, runtime
- Explain Saturation Limiter algorithm with examples
- Explain Soft Limiter spring-damper model
- Document dual enforcement strategy and thread safety
- Add best practices for joint limit configuration

Closes ros-controls#2262

@christophfroehlich christophfroehlich left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove the changes to the hardware_interface package (this is already in #3166)

Comment thread controller_manager/doc/userdoc.rst Outdated
Comment thread controller_manager/doc/userdoc.rst Outdated
ultrasage-danz and others added 3 commits April 18, 2026 19:32
Co-authored-by: Christoph Fröhlich <christophfroehlich@users.noreply.github.com>
@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open for 45 days with no activity. Please tag a maintainer for help on completing this PR, or close it if you think it has become obsolete.

@github-actions github-actions Bot added the stale label Jun 4, 2026

@christophfroehlich christophfroehlich left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove the changes to the hardware_interface package (this is already in #3166)

Removed detailed configuration instructions for joint limits, including parameter structure and methods of configuration.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Should controller_manager_services.py and launch_utils.py be documented?

2 participants